refactor: migrate avoid_using_api by solid-illiaaihistov · Pull Request #304 · solid-software/solid_lints

solid-illiaaihistov · 2026-06-30T16:18:37Z

Closes #249

gemini-code-assist

Code Review

This pull request refactors the avoid_using_api lint rule to utilize the analyzer-based RuleContext and RuleVisitorRegistry instead of custom_lint APIs. It replaces AvoidUsingApiLinter with AvoidUsingApiVisitor (extending SimpleAstVisitor), introduces several AST node helper extensions in node_utils.dart, refactors path matching in path_utils.dart, and replaces old integration tests with a comprehensive unit test suite. The review feedback suggests making the rootPath parameter in _getActiveEntries nullable to align with shouldSkipFile and passing context.package?.root.path directly instead of coalescing it to an empty string.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

…sitor

solid-illiaaihistov · 2026-07-01T10:37:40Z

I found a bug related to the use of severity in this rule, and I'm working on a fix.

… multiple lint codes

…o 249-migrate-avoid_using_api

solid-danylosafonov · 2026-07-01T11:17:51Z

+    }).toList();
+  }
+
+  List<AvoidUsingApiEntryParameters>? _cachedActiveEntries;


Should be before constructor

solid-danylosafonov · 2026-07-01T11:26:29Z

+    final element = node.element;
+    if (element is LocalFunctionElement ||
+        element is TopLevelFunctionElement ||
+        element is PropertyAccessorElement) {


Suggested change

final element = node.element;

if (element is LocalFunctionElement ||

element is TopLevelFunctionElement ||

element is PropertyAccessorElement) {

if (node.element

case LocalFunctionElement() ||

TopLevelFunctionElement() ||

PropertyAccessorElement()) {

solid-danylosafonov · 2026-07-01T11:33:14Z

+    if (source == null) return;
+
+    final className = entry.className;
+    final identifier = entry.identifier;
+
+    switch ((className, identifier)) {
+      case (null, null):
+        // banSource
+        if (matchesSource(node.sourceUrl, source)) {
+          reporter.atNode(node, _getLintCode(entry));
+        }
+      case (final String className, null):
+        // banClassFromSource
+        if (node.name.lexeme == className &&
+            matchesSource(node.sourceUrl, source)) {
+          reporter.atNode(node, _getLintCode(entry));
+        }
+      default:
+        break;
+    }


Suggested change

if (source == null) return;

final className = entry.className;

final identifier = entry.identifier;

switch ((className, identifier)) {

case (null, null):

// banSource

if (matchesSource(node.sourceUrl, source)) {

reporter.atNode(node, _getLintCode(entry));

}

case (final String className, null):

// banClassFromSource

if (node.name.lexeme == className &&

matchesSource(node.sourceUrl, source)) {

reporter.atNode(node, _getLintCode(entry));

}

default:

break;

}

if (source == null ||

entry.identifier != null ||

entry.className == null ||

!matchesSource(node.sourceUrl, source)) {

return;

}

reporter.atNode(node, _getLintCode(entry));

solid-danylosafonov · 2026-07-01T11:44:44Z

+    final source = entry.source;
+    if (source == null) return;
+
+    final className = entry.className;
+
+    switch ((className, entry.identifier)) {
+      case (final String className, null):
+        // banClassFromSource
+        final typeElement = node.declaredType?.element;
+        if (typeElement?.name == className &&
+            matchesSource(typeElement?.libraryUri, source)) {
+          reporter.atOffset(
+            offset: node.name.offset,
+            length: node.name.length,
+            diagnosticCode: _getLintCode(entry),
+          );
+        }
+      default:
+        break;
+    }


Suggested change

final source = entry.source;

if (source == null) return;

final className = entry.className;

switch ((className, entry.identifier)) {

case (final String className, null):

// banClassFromSource

final typeElement = node.declaredType?.element;

if (typeElement?.name == className &&

matchesSource(typeElement?.libraryUri, source)) {

reporter.atOffset(

offset: node.name.offset,

length: node.name.length,

diagnosticCode: _getLintCode(entry),

);

}

default:

break;

}

final source = entry.source;

final className = entry.className;

final typeElement = node.declaredType?.element;

if (source == null ||

entry.identifier != null ||

className == null ||

typeElement?.name != className ||

!matchesSource(typeElement?.libraryUri, source)) {

return;

}

reporter.atOffset(

offset: node.name.offset,

length: node.name.length,

diagnosticCode: _getLintCode(entry),

);

solid-danylosafonov · 2026-07-01T11:46:47Z

+        if (actualClassName != className) {
+          return;
+        }
+
+        if (node.constructorName.name?.name != expectedConstructorName) {
+          return;
+        }
+
+        if (!node.argumentList.containsNamed(namedParameter)) {
+          return;
+        }
+
+        if (matchesSource(
+          node.constructorName.type.element?.libraryUri,
+          source,
+        )) {


Suggested change

if (actualClassName != className) {

return;

}

if (node.constructorName.name?.name != expectedConstructorName) {

return;

}

if (!node.argumentList.containsNamed(namedParameter)) {

return;

}

if (matchesSource(

node.constructorName.type.element?.libraryUri,

source,

)) {

if (actualClassName == className &&

node.constructorName.name?.name == expectedConstructorName &&

node.argumentList.containsNamed(namedParameter) &&

matchesSource(

node.constructorName.type.element?.libraryUri,

source,

)) {

solid-danylosafonov · 2026-07-01T12:01:22Z

+    if (element == null) return false;
+
+    final target = element is InterfaceElement
+        ? element
+        : element.enclosingElement;
+    if (target == null) return false;
+
+    if (target is InterfaceElement || target is ExtensionElement) {
+      return target.name == className &&
+          matchesSource(target.libraryUri, source);
+    }
+
+    return false;


Suggested change

if (element == null) return false;

final target = element is InterfaceElement

? element

: element.enclosingElement;

if (target == null) return false;

if (target is InterfaceElement || target is ExtensionElement) {

return target.name == className &&

matchesSource(target.libraryUri, source);

}

return false;

final target = element is InterfaceElement

? element

: element?.enclosingElement;

if (target case InterfaceElement() || ExtensionElement()

when target != null) {

return target.name == className &&

matchesSource(target.libraryUri, source);

}

return false;

solid-danylosafonov · 2026-07-01T12:01:43Z

There are probably more similar refactors possible in this file that I missed

Thank you! I implemented similar improvements in other parts of this class as well.

…ethods

…ingApiVisitor to improve readability and structure

solid-danylosafonov · 2026-07-06T13:02:14Z

+  }
+
+  @override
+  void visitVariableDeclaration(VariableDeclaration node) {


Same is applicable to visitNamedType, visitSimpleIdentifier, visitInstanceCreationExpression, visitMethodInvocation

@override void visitVariableDeclaration(VariableDeclaration node) => _visit(node, super.visitVariableDeclaration, _checkVariableDeclaration); void _visit<T>( T node, void Function(T) visitSuper, void Function( T, AvoidUsingApiEntryParameters, DiagnosticReporter, ) visitEntry, ) { visitSuper(node); final resolved = _resolveContext(); if (resolved == null) return; final (:activeEntries, :reporter) = resolved; for (final entry in activeEntries) { visitEntry(node, entry, reporter); } }

Done!
Thank you!

solid-danylosafonov · 2026-07-06T13:02:28Z

+    }
+  }
+
+  bool _isMemberOrClass(Element? element, String className, String source) {


seems like it can be extracted to util?

solid-danylosafonov · 2026-07-06T13:08:06Z

+    final source = entry.source;
+    final className = entry.className;
+    final namedParameter = entry.namedParameter;
+    if (source == null ||
+        className == null ||
+        namedParameter == null ||
+        node.methodName.name != entry.identifier) {
+      return;
+    }
+
+    final enclosingElement = node.methodName.element?.enclosingElement;
+    if (enclosingElement != null &&
+        enclosingElement.name == className &&
+        node.argumentList.containsNamed(namedParameter) &&
+        matchesSource(enclosingElement.libraryUri, source)) {
+      reporter.atNode(node.methodName, _getLintCode(entry));
+    }


Suggested change

final source = entry.source;

final className = entry.className;

final namedParameter = entry.namedParameter;

if (source == null ||

className == null ||

namedParameter == null ||

node.methodName.name != entry.identifier) {

return;

}

final enclosingElement = node.methodName.element?.enclosingElement;

if (enclosingElement != null &&

enclosingElement.name == className &&

node.argumentList.containsNamed(namedParameter) &&

matchesSource(enclosingElement.libraryUri, source)) {

reporter.atNode(node.methodName, _getLintCode(entry));

}

final AvoidUsingApiEntryParameters(:source, :className, :namedParameter) =

entry;

final methodName = node.methodName;

final enclosingElement = methodName.element?.enclosingElement;

if (source == null ||

className == null ||

namedParameter == null ||

methodName.name != entry.identifier ||

enclosingElement == null ||

enclosingElement.name != className ||

!node.argumentList.containsNamed(namedParameter) ||

!matchesSource(enclosingElement.libraryUri, source)) {

return;

}

reporter.atNode(methodName, _getLintCode(entry));

solid-danylosafonov · 2026-07-06T13:10:44Z

+      return;
+    }
+
+    reporter.atNode(node, _getLintCode(entry));


This is repeated 8 times, why don't we wrap reporter into a function when we return it from _resolveContext so it looks more like:

Suggested change

reporter.atNode(node, _getLintCode(entry));

report(node);

…ied traversal method and moving member checks to extensions

refactor: migrate avoid_using_api

3165380

solid-illiaaihistov linked an issue Jun 30, 2026 that may be closed by this pull request

Migrate avoid_using_api #249

Open

gemini-code-assist Bot reviewed Jun 30, 2026

View reviewed changes

Comment thread lib/src/lints/avoid_using_api/visitors/avoid_using_api_visitor.dart

Comment thread lib/src/lints/avoid_using_api/visitors/avoid_using_api_visitor.dart

refactor: update rootPath parameter to nullable in avoid_using_api_vi…

82960eb

…sitor

Illia Aihistov added 3 commits July 1, 2026 14:36

fix: upgrade avoid_using_api to support per-entry severity levels and…

2dccbeb

… multiple lint codes

Merge remote-tracking branch 'upstream/analysis_server_migration' int…

8992813

…o 249-migrate-avoid_using_api

test: implement getRuleOptionsForFile in FakeAnalysisOptionsLoader

3f4e2fd

solid-danylosafonov reviewed Jul 1, 2026

View reviewed changes

Illia Aihistov added 2 commits July 1, 2026 17:07

refactor: simplify logic and reduce nesting in AvoidUsingApiVisitor m…

f818fe5

…ethods

refactor: replace conditional logic with switch expression in AvoidUs…

a1ea908

…ingApiVisitor to improve readability and structure

solid-danylosafonov reviewed Jul 6, 2026

View reviewed changes

refactor: simplify visitor logic by abstracting reporting into a unif…

1999e67

…ied traversal method and moving member checks to extensions

Uh oh!

Conversation

solid-illiaaihistov commented Jun 30, 2026

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

solid-illiaaihistov commented Jul 1, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants